FlowPosition Properties
An object defining properties for the FlowPosition class.
TimeoutOptions
Options defining the timeout behavior for the flow position.
Type: IFlowTimeoutOptions
Caption
The caption dictionary representing localized captions for the flow object.
Type: Dictionary<string, string>
EnablePushNotification
Gets or sets a value indicating whether push notification is enabled.
Type: bool
ShowInFlowHistory
Specifies if the position should be visible in the flow history.
Type: bool
HideApporoverInHistory
Determines whether the approver should be hidden in the flow history.
Type: bool
TimeoutHour
The number of hours set for the timeout duration.
Type: int
GeolocationOptions
Geolocation-related options for the flow position.
Type: IFlowGeolocationOptions
Id
The unique identifier of the flow position.
Type: long
NotificationMessage
Gets the notification message associated with the message.
Type: Dictionary<string, string>
ValueType
Indicates the type of the flow position, such as user or initiator.
Type: FlowPositionValueType
Accepted Values:
Name Value ConstantPosition 0 FlowInitiator 2 ConstantUser 8
EventsToCheck
A list of event names to monitor for the flow position.
MailSubject
Gets the mail subject associated with the message.
Type: Dictionary<string, string>
Key
A unique identifier for the workflow step.
Type: string
AutoOpenApprovalOption
Automatically opens approval options for the current position.
Type: bool
TimeoutMinute
The number of minutes set for the timeout duration.
Type: int
Code
The code associated with the flow position, typically representing a username.
Type: string
Name
Name for the workflow step.
Type: string
EnableSendMail
Gets or sets a value indicating whether sending mail is enabled.
Type: bool
Events
A read-only list of events related to the flow position.
Type: IReadOnlyList<IEvent>
MailMessage
Gets the mail message associated with the message.
Type: Dictionary<string, string>
TimeoutDuration
The total timeout duration in a TimeSpan format.
Type: TimeSpan
IsCustomMailMessage
Gets or sets a value indicating whether the mail message is custom.
Type: bool
CustomMailMessage
Gets the custom mail message associated with the message.
Type: Dictionary<string, string>
MessageOptions
Gets or sets the message options.
Type: IFlowMessageOptions
RequestIsNecessaryIfDocumentChanged
Requires approval if the associated document has been modified.
Type: bool
Email
The email address linked to the current flow position.
Type: string
Description
A descriptive name for the flow position, often combining first and last names.
Type: string
WorkflowCodeInstance
The workflow code instance associated with the flow object.
Type: IWorkflowCode
Documents
A list of documents associated with the flow position.
CachedDMObjects
The cached document management objects related to the flow object.
Type: IRuntimeDMObjects
WebNotificationOptions
Gets or sets the web notification options.
NotificationCaption
Gets the notification caption associated with the message.
Type: Dictionary<string, string>
Attachments
Gets the list of attachments associated with the message.
Type: IReadOnlyList<string>
ForwardingOptions
Options defining forwarding behavior for the flow position.
Type: IForwardingOptions
TypeCode
The type code associated with the flow object.
Type: WorkflowItemTypeCode
Accepted Values:
Name Value FlowComment -1 FlowStart 10 FlowEnd 11 FlowPosition 15 FlowAssign 21 FlowCompare 22 FlowOr 24 FlowAnd 25 FlowMail 26 FlowProfession 27 FlowDepartment 28 Variable 30 FlowScript 31 FlowNode 33 FlowGroup 37 FlowTimer 39 FlowTimerStarter 40 FlowTimerStopper 41 FlowApprovalCancellar 42 Pauser 44 SubFlowCall 51 SubFlowBegin 52 SubFlowEnd 53 FlowPushNotification 54 FlowDocument 56 FlowCreateDocument 57 FlowDocumentSynchronizer 58 FlowStarterPosition 59 FlowDocumentState 63 FlowUniqueIdCreator 65 FlowSetDocumentId 66 FlowDeleteDocument 67 FlowPDFExport 68 FlowXMLExport 69 FlowMailSender 75 FlowParallel 79 FlowContinue 80 FlowTrigger 81 FlowActionCreator 82 FlowDigitallySigning 83 FlowGptPrompt 84
DoNotSendRequestIfProcessed
Indicates whether a request should be avoided if already processed.
Type: bool
CalculateUsingHolidays
Specifies if holiday calculations should be included in timeouts.
Type: bool
TimeoutDay
The number of days set for the timeout duration.
Type: int
CalculateUsingWorkingHours
Specifies if working hours should be considered in timeout calculations.
Type: bool
NotificationOptions
Gets or sets the push notification options.